add achitectural overview#128
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an architectural overview to help contributors understand the extension’s client/server split and manager responsibilities, and annotates key server-side manager entry points with high-level XML summaries.
Changes:
- Added
ARCHITECTURE.mdwith a component-level overview, repository layout, and end-to-end query flow. - Linked the new architecture doc from
CONTRIBUTING.md. - Added/expanded XML
<summary>documentation on several core server manager classes to align with the architectural narrative.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Server/Symbols/SymbolManager.cs | Adds class-level summary explaining the GlobalState ownership and serialized symbol loading via TaskQueue. |
| src/Server/Server.cs | Adds class-level summary describing the server’s coordinator role and host-bridged seams. |
| src/Server/Querying/QueryManager.cs | Adds class-level summary describing query orchestration across symbols + connections + directives. |
| src/Server/Documents/DocumentManager.cs | Adds class-level summary describing document tracking and synchronization with text + globals changes. |
| src/Server/Diagnostics/DiagnosticsManager.cs | Adds class-level summary describing debounced/serialized diagnostics recomputation and publishing. |
| CONTRIBUTING.md | Adds an “Architecture” section linking to the new architecture overview doc. |
| ARCHITECTURE.md | Introduces a comprehensive architecture overview document (new file). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.